Skip to content

docs: convert remaining prose .rst to MyST .md (pass 2)#103

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/rst-to-myst-md-pass2
May 4, 2026
Merged

docs: convert remaining prose .rst to MyST .md (pass 2)#103
Jammy2211 merged 1 commit into
mainfrom
feature/rst-to-myst-md-pass2

Conversation

@Jammy2211
Copy link
Copy Markdown
Collaborator

Summary

Continues the rst→md migration started in PyAutoFit#1245. Converts the project README from RST to Markdown.

  • README.rstREADME.md
  • pyproject.toml: readme content-type → text/markdown
  • MANIFEST.in: ships README.md in the sdist

Test plan

  • CI green (unit tests + url_check)
  • PyPI long_description renders cleanly under text/markdown

🤖 Generated with Claude Code

Switches the project README from RST to MyST Markdown for consistency
with the rest of the docs (cf. PyAutoFit#1245). Updates pyproject.toml
to declare the new content-type so PyPI renders the long_description
correctly, and updates MANIFEST.in to ship the new file in the sdist.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit 98eba98 into main May 4, 2026
4 checks passed
@Jammy2211 Jammy2211 deleted the feature/rst-to-myst-md-pass2 branch May 4, 2026 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant